

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
    <style>
    /* base */
    html,
    body,
    .container {
      width: 100%;
      height: 100%;
    }

    a,
    a:link,
    a:visited {
      text-decoration: none;
      color: inherit;
    }

    ul {
      list-style: none;
    }

    *,
    ::before,
    ::after {
      box-sizing: border-box;
      margin: 0;
      padding: 0;
    }

    *:focus {
      outline: 0;
    }

    .container {
      display: flex;
      padding-top: 20px;
    }

    /* Nav */
    .container .doc-nav {
      position: fixed;
      height: 100%;
      margin: 0 30px 0 40px;
      width: 280px;
    }

    .doc-nav .nav-header {
      display: flex;
      align-items: center;
      box-sizing: border-box;
      background-color: rgb(240, 241, 242);
      height: 40px;
      padding: 16px;
      font-size: 18px;
      font-weight: 500;
      color: rgb(62, 64, 66);
      cursor: pointer;
    }

    .doc-nav .nav-content {
      height: calc(100% - 40px);
      overflow-y: auto;
      color: rgb(32, 34, 36);
    }

    .doc-nav .nav-content .nav-list,
    .doc-nav .nav-content .nav-sub-list {
      line-height: 1.5rem;
    }

    .doc-nav .nav-content .nav-label {
      display: inline-block;
      position: relative;
      padding: 2px 0 2px 20px;
      margin-bottom: 4px;
    }

    .doc-nav .nav-content .nav-sub-label {
      position: relative;
      padding: 2px 0 2px 40px;
      font-size: 14px;
    }

    .doc-nav .nav-content .nav-sub-label:hover {
      text-decoration: underline;
    }

    .doc-nav .nav-content .nav-list .nav-label.group::before {
      border-bottom: 0.25rem solid transparent;
      border-left: 0.25rem solid #6e7072;
      border-right: 0;
      border-top: 0.25rem solid transparent;
      content: '';
      display: block;
      height: 0;
      left: 0.5rem;
      position: absolute;
      top: 0.625rem;
      transition: transform 0.1s linear;
      width: 0;
    }

    .doc-nav .nav-content .nav-list .nav-label.group.active::before {
      transform: rotate(90deg);
    }

    /* doc content */
    .container .doc-content {
      position: fixed;
      height: 100%;
      width: calc(100% - 80px - 40px - 30px - 240px);
      right: 0%;
      overflow-y: auto;
    }

    .doc-title {
      border-bottom: 1px solid #dcdee0;
      font-size: 22px;
      margin: 8px 0 0;
      padding-bottom: 16px;
    }

    .doc-content h3 {
      font-size: 24px;
      font-weight: 600;
      margin: 24px 0;
    }

    .doc-content h4 {
      font-size: 22px;
      font-weight: 500;
      margin: 30px 0 8px;
    }

    .doc-content h4 span {
      color: #007d9c;
    }

    .doc-content .doc-declare {
      background-color: #fafafa;
      border-radius: 5px;
      border: 1px solid #ccc;
      font-size: 14px;
      overflow-x: auto;
      padding: 10px;
      tab-size: 4;
      line-height: 20px;
    }

    .doc-content .doc-comment {
      font-size: 16px;
      margin: 16px 0;
      line-height: 24px;
      word-break: break-word;
    }
  </style>

</head>
<body>
  <div class="container">
    <div class="doc-nav">
      <a href="#Documentation" class="nav-header">Documentation</a>
      <nav class="nav-content">
        <ul class="nav-list">
          <li>
            <a href="#includes" class="nav-label">Includes</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#lwip/arch.h" class="nav-sub-label">lwip/arch.h</a>
              </li>
      

              <li>
                <a href="#lwip/opt.h" class="nav-sub-label">lwip/opt.h</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#macros" class="nav-label">Macros</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#SIO_H" class="nav-sub-label">SIO_H</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#functions" class="nav-label">Functions</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#sio_open" class="nav-sub-label">sio_open</a>
              </li>
      

              <li>
                <a href="#sio_send" class="nav-sub-label">sio_send</a>
              </li>
      

              <li>
                <a href="#sio_recv" class="nav-sub-label">sio_recv</a>
              </li>
      

              <li>
                <a href="#sio_read" class="nav-sub-label">sio_read</a>
              </li>
      

              <li>
                <a href="#sio_tryread" class="nav-sub-label">sio_tryread</a>
              </li>
      

              <li>
                <a href="#sio_write" class="nav-sub-label">sio_write</a>
              </li>
      

              <li>
                <a href="#sio_read_abort" class="nav-sub-label">sio_read_abort</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#vars" class="nav-label">Vars</a>
            
            <ul class="nav-sub-list">
            
            </ul>
            
          </li>
          <li>
            <a href="#consts" class="nav-label">Consts</a>
            
            <ul class="nav-sub-list">
            
            </ul>
            
          </li>
          <li>
            <a href="#types" class="nav-label">Types</a>
            
            <ul class="nav-sub-list">
            
            </ul>
            
          </li>
          <li>
            <a href="#typedefs" class="nav-label">Typedefs</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#sio_fd_t" class="nav-sub-label">sio_fd_t</a>
              </li>
      
            </ul>
            
          </li>
        </ul>
      </nav>
    </div>
    <div class="doc-content">
      <h2 id="Documentation" class="doc-title">Documentation</h2>
      <h3 id="includes">Includes</h3>
      

      <h4 id="lwip/arch.h"><span>lwip/arch.h</span></h4>
      <pre class="doc-declare"><code>#include "lwip/arch.h"
</code></pre>
      <pre class="doc-comment">#include "lwip/arch.h"
</pre>

      <h4 id="lwip/opt.h"><span>lwip/opt.h</span></h4>
      <pre class="doc-declare"><code>#include "lwip/opt.h"
</code></pre>
      <pre class="doc-comment">#include "lwip/opt.h"
</pre>
      <h3 id="macros">Macros</h3>
      

      <h4 id="SIO_H">Marco <span>SIO_H</span></h4>
      <pre class="doc-declare"><code>#define SIO_H
</code></pre>
      <pre class="doc-comment"></pre>
      <h3 id="functions">Functions</h3>
      

      <h4 id="sio_open">Func <span>sio_open</span></h4>
      <pre class="doc-declare"><code>sio_fd_t sio_open(u8_t devnum);</code></pre>
      <pre class="doc-comment">/**
 * Opens a serial device for communication.
 *
 * @param devnum device number
 * @return handle to serial device if successful, NULL otherwise
 */</pre>

      <h4 id="sio_send">Func <span>sio_send</span></h4>
      <pre class="doc-declare"><code>void sio_send(u8_t c, sio_fd_t fd);</code></pre>
      <pre class="doc-comment">/**
 * Sends a single character to the serial device.
 *
 * @param c character to send
 * @param fd serial device handle
 *
 * @note This function will block until the character can be sent.
 */</pre>

      <h4 id="sio_recv">Func <span>sio_recv</span></h4>
      <pre class="doc-declare"><code>u8_t sio_recv(sio_fd_t fd);</code></pre>
      <pre class="doc-comment">/**
 * Receives a single character from the serial device.
 *
 * @param fd serial device handle
 *
 * @note This function will block until a character is received.
 */</pre>

      <h4 id="sio_read">Func <span>sio_read</span></h4>
      <pre class="doc-declare"><code>u32_t sio_read(sio_fd_t fd, u8_t *data, u32_t len);</code></pre>
      <pre class="doc-comment">/**
 * Reads from the serial device.
 *
 * @param fd serial device handle
 * @param data pointer to data buffer for receiving
 * @param len maximum length (in bytes) of data to receive
 * @return number of bytes actually received - may be 0 if aborted by sio_read_abort
 *
 * @note This function will block until data can be received. The blocking
 * can be cancelled by calling sio_read_abort().
 */</pre>

      <h4 id="sio_tryread">Func <span>sio_tryread</span></h4>
      <pre class="doc-declare"><code>u32_t sio_tryread(sio_fd_t fd, u8_t *data, u32_t len);</code></pre>
      <pre class="doc-comment">/**
 * Tries to read from the serial device. Same as sio_read but returns
 * immediately if no data is available and never blocks.
 *
 * @param fd serial device handle
 * @param data pointer to data buffer for receiving
 * @param len maximum length (in bytes) of data to receive
 * @return number of bytes actually received
 */</pre>

      <h4 id="sio_write">Func <span>sio_write</span></h4>
      <pre class="doc-declare"><code>u32_t sio_write(sio_fd_t fd, u8_t *data, u32_t len);</code></pre>
      <pre class="doc-comment">/**
 * Writes to the serial device.
 *
 * @param fd serial device handle
 * @param data pointer to data to send
 * @param len length (in bytes) of data to send
 * @return number of bytes actually sent
 *
 * @note This function will block until all data can be sent.
 */</pre>

      <h4 id="sio_read_abort">Func <span>sio_read_abort</span></h4>
      <pre class="doc-declare"><code>void sio_read_abort(sio_fd_t fd);</code></pre>
      <pre class="doc-comment">/**
 * Aborts a blocking sio_read() call.
 *
 * @param fd serial device handle
 */</pre>
      <h3 id="vars">Vars</h3>
      
      <h3 id="consts">Consts</h3>
      
      <h3 id="types">Types</h3>
      
      <h3 id="typedefs">Typedefs</h3>
      

      <h4 id="sio_fd_t">Typedef <span>sio_fd_t</span></h4>
      <pre class="doc-declare"><code>typedef void * sio_fd_t;</code></pre>
      <pre class="doc-comment"></pre>
    </div>
  </body>
</html>
            